home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #5 & #6 / Amiga Plus CD - 1995 - No. 5 and 6.iso / tex / macros / distribs / doc / readme.mz0 < prev   
Text File  |  1992-09-07  |  3KB  |  102 lines
  1.  
  2. This file is part of the doc package.
  3. -------------------------------------
  4.  
  5. \def\filedate{92/08/30}
  6.  
  7. Copyright (C) 1989-1992 by Frank Mittelbach.  All rights reserved.
  8.  
  9. IMPORTANT NOTICE:
  10.  
  11. You are not allowed to change this readme file.
  12.  
  13. For distribution of unchanged and changed versions see file readme.mz.
  14.  
  15.  
  16. This is the basic package for all distributions coming from Mainz. It
  17. contains doc.sty and the docstrip.tex file which are utility programs
  18. that are used by other packages to produce the documentation and the
  19. executable versions from the distributed .doc files.
  20.  
  21. The file doc.doc was updated by Dave Love, the file docstrip.doc was
  22. rewritten by Johannes Braams with support from Denys Duchier. A big
  23. thank you to all of them.
  24.  
  25.  
  26. You should get the following files:
  27.  
  28.  
  29.   doc.doc    The doc style for LaTeX used to produce documentation.
  30.  
  31.   newdoc.doc    The newdoc style for LaTeX containing test code that may
  32.                 find its way into doc.doc some day.
  33.  
  34.   docstrip.doc  The docstrip utility which extracts executable files
  35.                 from `.doc' sources.
  36.  
  37.   readme.mz     File that describes distribution restrictions and gives
  38.                 a short overview about other distributions from Mainz.
  39.  
  40.   readme.mz0    This file.
  41.  
  42.   install.mz0   This is the installation script that will produce
  43.                 the executable files in this package and the driver
  44.         files for the documentation.
  45.  
  46.  
  47.  
  48. To produce the executable files please run install.mz0 through LaTeX or
  49. TeX, i.e., say
  50.  
  51.    latex install.mz0
  52.  
  53. or whatever is necessary to run process a file with LaTeX on your
  54. system.  This will generate all necessary files. If you already have
  55. older versions of the files, the script will ask whether or not you
  56. want to overwrite those versions.
  57.  
  58. This script will generate:
  59.  
  60.   doc.sty    The doc option file for making documentation.
  61.   newdoc.sty    The newdoc option file for making documentation.
  62.   docstrip.tex    The docstrip utility.
  63.  
  64.   doc.drv    Driver file to produce the documentation for doc.
  65.   docstrip.drv    Driver file to produce the documentation for docstrip.
  66.  
  67.   gind.ist    Makeindex style file to produce the index.
  68.   gglo.ist    Makeindex style file to produce the history listing.
  69.  
  70.  
  71. To produce the documentation run the corresponding driver files
  72. through LaTeX.  You are allowed to change the driver files to get a
  73. special layout, etc. To get an index and history listing run the idx
  74. and glo files through the program MAKEINDEX.  MAKEINDEX should be part
  75. of every LaTeX installation.
  76.  
  77. Please note that you need to specify a style file for MAKEINDEX:
  78.  
  79.    gind.ist   for the index file   (result should be named *.ind)
  80.    gglo.ist   for the history file (result should be named *.gls)
  81.  
  82. Sample invocation for Unix:
  83.  
  84.    makeindex -s gind.ist doc
  85.    makeindex -s gglo.ist -o doc.gls doc.glo
  86.  
  87. The \fileversion and \filedate lines below are generated so that you can
  88. easily check differences from your version by using diff etc.
  89.  
  90.  
  91.  
  92.  
  93.         doc.bug:         \filedate{92/08/24}
  94.         doc.doc:         \fileversion{v1.7k} 
  95.         doc.doc:         \filedate{92/08/24}
  96.         docstrip.doc:    \filename{docstrip.doc}
  97.         docstrip.doc:    \fileversion{2.0r}
  98.         docstrip.doc:    \filedate{92/08/17}
  99.         install.mz0:     \filedate{92/08/30}
  100.         readme.mz:       \filedate{92/07/07}
  101.         readme.mz0:      \filedate{92/08/30}
  102.